[BUG] Fix public API decorator type annotations. #1397
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #1397 +/- ##
==========================================
+ Coverage 87.79% 87.80% +0.01%
==========================================
Files 60 60
Lines 6031 6036 +5
==========================================
+ Hits 5295 5300 +5
Misses 736 736
|
samster25
approved these changes
Sep 21, 2023
jaychia
approved these changes
Sep 21, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR fixes the type annotations for functions/methods that are wrapped with the public API decorator. Namely, we replace
Callable[..., Any]for the input and return type of the decorator withCallable[P, T], whereT = TypeVar("T")andP = ParamSpec("P"); we then bindTto the return type andP.argsandP.kwargsto the args and kwargs, respectively, of the wrapper function. This ensures that the type annotations of the wrapped function/method are properly propagated to the returned wrapper function.